<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>uartps: xuartps_low_echo_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">uartps
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xuartps__low__echo__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xuartps_low_echo_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the hardware interface. </p>
<p>First, certain character sequence is output onto the terminal. Then any characters typed in are echoed back, for letters, cases are switched. An 'ESC' character terminates the execution of the example.</p>
<p>This example requires an external SchmartModule to be connected to the appropriate pins for the device through a daughter board. The test uses the default settings of the device: . baud rate of 9600 . 8 bits data . 1 stop bit . no parity</p>
<dl class="section note"><dt>Note</dt><dd>The test hangs if communication channel from the user terminal to the device is broken.</dd></dl>
<p>MODIFICATION HISTORY: </p>
<pre>
Ver   Who    Date     Changes
</p>
<hr/>
<p>
1.00a drg/jz 01/13/10 First release
3.4   ms     01/23/17 Added xil_printf statement in main function to
                      ensure that "Successfully ran" and "Failed" strings
                      are available in all examples. This is a fix for
                      CR-965028.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a012e79e774af8eeb985f9fdfac38de37"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xuartps__low__echo__example_8c.html#a012e79e774af8eeb985f9fdfac38de37">UartPsEchoExample</a> (u32 UartBaseAddress)</td></tr>
<tr class="memdesc:a012e79e774af8eeb985f9fdfac38de37"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function does a minimal test on the UART device using the hardware interface.  <a href="#a012e79e774af8eeb985f9fdfac38de37">More...</a><br/></td></tr>
<tr class="separator:a012e79e774af8eeb985f9fdfac38de37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xuartps__low__echo__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the Uart Echo example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the Uart Echo example. </p>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, XST_FAILURE if unsuccessful</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="xuartps__low__echo__example_8c.html#a012e79e774af8eeb985f9fdfac38de37">UartPsEchoExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a012e79e774af8eeb985f9fdfac38de37"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int UartPsEchoExample </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>UartBaseAddress</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function does a minimal test on the UART device using the hardware interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">UartBaseAddress</td><td>is the base address of the device</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, XST_FAILURE if unsuccessful</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__uartps.html#gae297afa5ad30bb459ae92c6289bf24d3">XUARTPS_CR_EN_DIS_MASK</a>, <a class="el" href="group__uartps.html#ga90a3cb2c33dba6a5b888f7324d1c5135">XUARTPS_CR_OFFSET</a>, <a class="el" href="group__uartps.html#ga31a05c9637d59b0631b43758a78d605e">XUARTPS_CR_RX_EN</a>, <a class="el" href="group__uartps.html#gaf22f08ec08cbe06a53efbd44a43b8096">XUARTPS_CR_TX_EN</a>, <a class="el" href="group__uartps.html#ga12e256a5c0dd76b4c3ce5952382a0400">XUARTPS_FIFO_OFFSET</a>, <a class="el" href="group__uartps.html#gac8b8f06d10cf178227ce88c140d78eb4">XUartPs_IsReceiveData</a>, <a class="el" href="group__uartps.html#gaf1507e8d7b12983484a0ab5436a51970">XUartPs_IsTransmitFull</a>, <a class="el" href="group__uartps.html#ga16be7534dc3d678f8abcfeb87e6a4f7e">XUartPs_ReadReg</a>, and <a class="el" href="group__uartps.html#gab541297d822b163193a2e47305987ab6">XUartPs_WriteReg</a>.</p>

<p>Referenced by <a class="el" href="xuartps__low__echo__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
